home *** CD-ROM | disk | FTP | other *** search
/ Zen & the Art of Resourc…The BMUG Guide to ResEdit / Zen and the Art of Resource Editing - The BMUG Guide to ResEdit (1995).iso / Editors and Templates / hfdr Editor for ResEdit 2.1 / About the hfdr Editor next >
Text File  |  1991-07-30  |  5KB  |  128 lines
  1. †
  2.  
  3.  
  4. †
  5.  
  6.  
  7. The file ``hfdr Editor for ResEdit 2.1'' contains resources that add an editor and a picker for Finder help resources to ResEdit 2.1 (or later). Finder help resources are resources of type 'hfdr' that lets the Help Manager in System 7 display a help message, which is defined in the Finder help resource, when the cursor passes over the program's icon in the Finder. An example of this appears below.
  8.  
  9. †
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20. When you open the Finder help resource picker for a program (say ResEdit), a window similar to the following one will appear. It will show a representation of the Finder help resource and the data it contains or references.
  21.  
  22. †
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36. Upon opening a Finder help resource, the editor will open. A typical Finder help editor window looks like this:
  37.  
  38. †
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56. †
  57.  
  58.  
  59. The highest item in the window is a popup menu that lets you choose what form the help is in. The following picture shows the possible options in the menu.
  60.  
  61. †
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69. The first item in the Help menu is ``Skip this item.'' This simply means that there is no help for the program, even though there is a Finder help resource.
  70.  
  71. The next four items are used to specify that the actual help message is contained in another resource. That resource will be displayed in the test balloon below the popup menu (if it exists). When one of these items is selected, a field will show up which contains the resource ID of the associated resource. For the STR# resource, another field will show up that contains the string index number.
  72.  
  73. The last item, ``Pascal string,'' lets you store a help message directly into the Finder help resource by typing directly into the test balloon.
  74.  
  75. All Finder help resources must have an ID of -5696 to work correctly, and there may be only one Finder help resource for a program.
  76.  
  77. †
  78.  
  79. When the Finder help editor window is on the top it adds its own menu to the menu bar, with only one command. The menu look like the one below:
  80.  
  81. †
  82.  
  83.  
  84.  
  85. The Options command brings up a dialog, that lets you change some of the parameters for help resources. Inside Macintosh VI has a detailed description of these options.
  86.  
  87. Besides adding the hfdr menu, the Finder help editor changes the Resource menu to look like the one below. The second item will change depending on what type of help is used. 
  88.  
  89. †
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99. If a resource is used it will change to ``Open <resource type>''. Selecting it will open the resource, or create it if it doesn't exist. If there is no resource associated with the Finder help resource, it will change to ``Can't Open'' and will be dimmed. Another way to open an associated resource is to double click on the test balloon.
  100.  
  101. †
  102.  
  103.  
  104. The hfdr editor is only compatible with ResEdit versions 2.1 and later. The editor protocols for versions earlier that 2.1 are different and will not work with this editor. Although this editor edits System 7-specific resources, System 7 is not required for it to run. It will also work correctly under different system scripts.
  105.  
  106. The file ``hfdr Editor for ResEdit 2.1'' contains the hfdr editor and all its associated resources. Using ResEdit, copy ALL the resources in ``hfdr Editor for ResEdit 2.1'' into ResEdit or your ``ResEdit Preferences'' file. The Preferences file is in your System Folder (System 6.0.x) or the Preferences folder in your System Folder (System 7.0). You can copy into the running version of ResEdit so long as you don't replace resources in use; use common sense and make sure you have a backup copy of ResEdit. When pasting into a program with many large resources (like ResEdit), window updates may be relatively slow. Have patience!
  107.  
  108. †
  109.  
  110. This section describes several possible changes and enhancements to the Finder help editor. I won't make any guarantees about how soon I will implement them, if at all, because there is a severe lack of time. Among other things, I'm a high school student. (Read: remember homework?)
  111.  
  112. The first enhancement that I can think of is the ability to edit STR and STR# resources directly in the test balloon, like you edit Pascal strings. This would greatly simplify the process of creating Finder help for a program.
  113.  
  114. The only other changes I can think of are just changes in the way it already does things. For example, if you open a STR resource, change some of it (like the first letter on a line), and close the template, the left half of the text in the test balloon will remain unchanged for a little bit. This could be made to update much faster. Also, the way it displays TEXT/styl resources is somewhat clunky.
  115.  
  116. That's all I can think of now, but I'm sure you'll think of other improvements to be made while using it. I'm open to all suggestions!
  117.  
  118. †
  119.  
  120.  
  121. Chris A. Reed
  122. 3409 Clearview Drive
  123. San Angelo TX 76904
  124.  
  125. America Online: Chrisreed
  126.  
  127.  
  128. Version 1.1